docs: add pre-commit exclude pattern guidance for large/generated dirs#324
Merged
docs: add pre-commit exclude pattern guidance for large/generated dirs#324
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Benchmark
Details
| Benchmark suite | Current: 631218d | Previous: dbc9884 | Ratio |
|---|---|---|---|
tests/benchmarks/test_bench_core.py::test_bench_greet_default |
8836578.096736405 iter/sec (stddev: 8.890156692270802e-9) |
8728938.237929476 iter/sec (stddev: 2.6147850131389897e-8) |
0.99 |
tests/benchmarks/test_bench_core.py::test_bench_greet_with_name |
8998538.755694509 iter/sec (stddev: 1.0625865326875989e-8) |
8824487.488376206 iter/sec (stddev: 1.0764640102900196e-8) |
0.98 |
tests/benchmarks/test_bench_core.py::test_bench_greet_long_name |
5682740.12839345 iter/sec (stddev: 1.2707061353185103e-8) |
5218797.625415371 iter/sec (stddev: 2.8228318211772188e-8) |
0.92 |
tests/benchmarks/test_bench_logging.py::test_bench_get_logger |
1836906.4896003555 iter/sec (stddev: 1.706351144619163e-7) |
1632351.7689504097 iter/sec (stddev: 2.5443274722814504e-7) |
0.89 |
tests/benchmarks/test_bench_logging.py::test_bench_setup_logging |
529260.6212701318 iter/sec (stddev: 3.0782813289872925e-7) |
493165.5322141699 iter/sec (stddev: 5.251655780708425e-7) |
0.93 |
This comment was automatically generated by workflow using github-action-benchmark.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add commented-out
exclude:pattern examples to.pre-commit-config.yamlfor thecheck-added-large-filesanddetect-private-keyhooks. This gives contributors ready-made templates they can uncomment and adapt when projects have large data directories or non-secret key-like files that trigger false positives.Related Issue
Addresses #294
Type of Change
Changes Made
exclude:example aftercheck-added-large-fileshook for large data/generated directoriesexclude:example afterdetect-private-keyhook for directories with non-secret key-like patternsTesting
Checklist
doit format)doit lint)doit type_check)doit test)Additional Notes
Comment-only change to
.pre-commit-config.yaml. No functional behavior is altered. No tests are needed since no code is added or modified.